[WIP] feat: New SDK docs #293

HazAT · 2018-08-29T08:20:20Z

No description provided.

kamilogorek · 2018-09-03T08:59:58Z

src/collections/_documentation/learn/configuration.md

+---
+
+SDKs are configurable in many ways.  The options are largely standardized between SDKs but there are
+some differences to better acomodate platform peculiarities.  Options are set when the SDK is first


kamilogorek · 2018-09-03T09:02:51Z

src/collections/_documentation/learn/configuration.md

+{:.config-key}
+### repos
+
+For repository integration the repository identifiers need to be sent along.  For more information


integration,

kamilogorek · 2018-09-03T09:03:12Z

src/collections/_documentation/learn/configuration.md

+### attach-stacktrace
+
+When enabled stacktraces are automatically attached to all messages logged.  Note that stacktraces
+are always attached to exceptions but when this is set stacktraces are also sent with messages.  This


This, for instance,

kamilogorek · 2018-09-03T09:03:29Z

src/collections/_documentation/learn/configuration.md

+### send-default-pii
+
+If this flag is enabled then certain personally identifyable information is added by active
+integrations.  Without this flag they are never added to the event to begin with.  If possible


kamilogorek · 2018-09-03T09:04:32Z

src/collections/_documentation/learn/configuration.md

+### environment
+
+Sets the environment.  This string is freeform and not set by default.  A release can be associated
+with more than one environment to separate them im the UI (think `staging` vs `prod` or similar).


kamilogorek · 2018-09-03T09:05:13Z

src/collections/_documentation/learn/configuration.md

+{:.config-key}
+### send-default-pii
+
+If this flag is enabled then certain personally identifyable information is added by active


identefiable

kamilogorek · 2018-09-03T09:05:29Z

src/collections/_documentation/learn/configuration.md

+Can be used to supply a "server name".  When provided the name of the server is sent along and
+persisted in the event.  Note that for many integrations the server name actually corresponds to
+the device hostname even in situations where the machine is not actually a server.  Most SDKs
+will attempt to auto discover this value.


auto-discover

kamilogorek · 2018-09-03T09:05:47Z

src/collections/_documentation/learn/configuration.md

+
+* `never`: request bodies are never sent.
+* `small`: only small request bodies will be captured where the cutoff for small depends on the SDK (typically 4KB)
+* `medium`: medium sized requests and small requests will be captured. (typically 10KB)


medium-sized

kamilogorek · 2018-09-03T09:06:24Z

src/collections/_documentation/learn/configuration.md

+### before-breadcrumb
+
+This function is called with an SDK specific breadcrumb object before the breadcrumb is added to the
+scope.  When nothign is returned from the function the breadcrumb is dropped.


kamilogorek · 2018-09-03T09:06:39Z

src/collections/_documentation/learn/configuration.md

+
+When set a proxy can be configured that should be used for outbound requests.  This is also used for
+HTTPS requests unless a separate `https-proxy` is configured.  Note however that not all SDKs
+support a separate HTTPS proxy.  SDKs will attempt to default to the system wide configured proxy


system-wide

untitaker · 2018-09-03T09:02:16Z

src/collections/_documentation/learn/configuration.md

+{:.config-key}
+### max-breadcrumbs
+
+This variable controls the total amount of breadcrumbs that should be captured.  This defaults


Not sure if this is documented elsewhere, but this seems like a good place to tell how breadcrumbs work (i.e. it's a scrollback buffer, and this controls the size of that buffer)

untitaker · 2018-09-03T09:05:39Z

src/collections/_documentation/learn/configuration.md

+{% endsupported %}
+
+{:.config-key}
+### with-locals


Does it make sense to default this to true while send-default-pii is defaulting to false?

untitaker · 2018-09-03T09:05:54Z

src/collections/_documentation/learn/configuration.md

+This feature is off by default.
+
+{:.config-key}
+### send-default-pii


Not sure how this is rendered but there's no info on the default value

untitaker · 2018-09-03T09:06:42Z

src/collections/_documentation/learn/configuration.md

+
+## Hooks
+
+These options can be used to hook the SDK in various ways to customize the reporting of events.


This and the Transport Options are technically a subcategory of Common Options, right?

kamilogorek · 2018-09-03T09:07:12Z

src/collections/_documentation/learn/configuration.md

+## Integration Configuration
+
+For many platform SDKs integrations can be configured alongside it.  On some platforms that
+happens as part of the `init()` call, in some others different patterns apply.


kamilogorek · 2018-09-03T09:07:30Z

src/collections/_documentation/learn/configuration.md

+queue and this queue is given a certain amount to drain pending events.  The default is SDK specific
+but typically around 2 seconds.  Setting this value too low will most likely cause problems for
+sending events from command line applications.  Setting it too high will cause the application to
+block for long time for users with network connectivity problems.


kamilogorek · 2018-09-03T09:08:03Z

src/collections/_documentation/learn/configuration.md

+## Integration Configuration
+
+For many platform SDKs integrations can be configured alongside it.  On some platforms that
+happens as part of the `init()` call, in some others different patterns apply.


kamilogorek · 2018-09-03T09:08:24Z

src/collections/_documentation/learn/configuration.md

+### transport
+
+This switches out the transport that is used to send events.  How this works depends on the SDK.  It
+can for instance be used to capture events for unit-testing or to send it through some more complex


It can, for instance,

kamilogorek · 2018-09-03T09:08:36Z

src/collections/_documentation/learn/configuration.md

+When set a proxy can be configured that should be used for outbound requests.  This is also used for
+HTTPS requests unless a separate `https-proxy` is configured.  Note however that not all SDKs
+support a separate HTTPS proxy.  SDKs will attempt to default to the system wide configured proxy
+if possible.  For instance on unix systems the `http_proxy` environment variable will be picked up.


kamilogorek · 2018-09-04T10:19:19Z

src/collections/_documentation/learn/getting-started-config/electron.md

+application startup:
+
+```javascript
+import * as sentry from '@sentry/electron';


uppercase Sentry

* master: Manual setup instructions in settings.gradle (#309) Add link to GHE on Integrations page fix (ui): broken layout on certain pages due to flexbox Remove twitter, linkedin, bing build: Increase timeout Add a space fix: switch to jsx highlighting for react docs Fix: broken link to angular error handler docs remove log Handle empty search Document payload size for javascript SDK

@ckj

…pres cc @ckj

mickeyreiss · 2019-01-09T23:24:41Z

src/collections/_documentation/clientdev/attributes.md

+`culprit`
+
+: The name of the culprit which caused this exception. This attribute is
+  deprecated.


It would be helpful if this documented the preferred alternative that replaces culprit.

There is no real replacement for this attribute. The server sets it now. To override it the client can supply it.

Ah, thanks for clarifying. For context, I am trying to integrate logrus and sentry in go. Here's what they provide:

https://github.com/sirupsen/logrus/blob/v1.3.0/entry.go#L63-L64

If you have a single stacktrace frame i think it would be best to report a single thread with a stacktrace of a single frame.

HazAT and others added 4 commits August 29, 2018 10:16

feat: Move files from temp docs repo

68bac3d

Merge branch 'master' into feature/new-sdks

6544c20

Merge branch 'master' into feature/new-sdks

17f9e9e

ref: Updated docs for options

56da51f

kamilogorek reviewed Sep 3, 2018

View reviewed changes

fix: Fix the unsupported hint not showing correctly

1fbed9e

kamilogorek reviewed Sep 3, 2018

View reviewed changes

untitaker reviewed Sep 3, 2018

View reviewed changes

kamilogorek reviewed Sep 3, 2018

View reviewed changes

mitsuhiko and others added 4 commits September 3, 2018 11:28

feat: Updated context docs

6ab1a64

feat: Initial pass over user feedback

9bca828

fix: typos and browser platform

d9b5df3

fix: Add more commas

eb9a407

kamilogorek reviewed Sep 4, 2018

View reviewed changes

HazAT added 4 commits September 4, 2018 14:32

fix: Typos and minor stuff

a268deb

feat: Prepre new platform page

580539b

fix: Move browser to subcategory

672acfc

cameronmcefee and others added 9 commits September 17, 2018 14:14

Merge branch 'master' into ref/wizard

dd3de70

Merge branch 'feature/new-sdks' into ref/wizard

863eef8

remove empty wizard

f0b1d99

remove duplicated page

662a5b3

tweak legacy cases

c6d415f

feat: Added python and rust to with-scope

002ca57

Ok, let's do it this way

3c589da

ref: moved some relay stuff around

aff3f3d

more tweaks to get the right output

2b4174f

kamilogorek mentioned this pull request Sep 18, 2018

Wrong stacktrace getsentry/sentry-javascript#1540

Closed

8 tasks

untitaker and others added 17 commits September 18, 2018 13:29

fix: relay config

17a848f

fix: More fixes

48fc05f

fix: Move alert out of wizard

b55e7d2

add platform slug to doc_link

56a4f3c

feat: Rename remove PII type

10ca3ab

update doc_link universally

5501b80

Merge branch 'ref/wizard' into feature/new-sdks

3eec6b5

always prepend doclink

7fd297d

break up doc_link asignment to be a little clearer

7aeb96c

fix: more specific target for updating the platform switcher text

996c674

Define platform api classes outside of the hook itself

3cf7463

Add script for direct api build

213c8e6

Got my order wrong

1a05829

Collapse markup in highlighted sections to ensure that sentry styles …

fb4345f

…pres cc @ckj

feat: Fix wizard with links, platforms and js

ed247f3

feat: finished docs

ca02385

Merge branch 'master' into feature/new-sdks

6bd538f

mitsuhiko merged commit 22e7ff5 into master Sep 19, 2018

mickeyreiss reviewed Jan 9, 2019

View reviewed changes

github-actions bot locked and limited conversation to collaborators Dec 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] feat: New SDK docs #293

[WIP] feat: New SDK docs #293

HazAT commented Aug 29, 2018

kamilogorek Sep 3, 2018 •

edited

Loading

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

untitaker Sep 3, 2018

untitaker Sep 3, 2018

untitaker Sep 3, 2018

untitaker Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 3, 2018

kamilogorek Sep 4, 2018

mickeyreiss Jan 9, 2019

mitsuhiko Jan 9, 2019

mickeyreiss Jan 9, 2019

mitsuhiko Jan 9, 2019


		## Hooks

		These options can be used to hook the SDK in various ways to customize the reporting of events.

[WIP] feat: New SDK docs #293

[WIP] feat: New SDK docs #293

Conversation

HazAT commented Aug 29, 2018

kamilogorek Sep 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kamilogorek Sep 3, 2018 •

edited

Loading